home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / chbevx.z / chbevx
Encoding:
Text File  |  2002-10-03  |  8.6 KB  |  265 lines
  1.  
  2.  
  3.  
  4. CCCCHHHHBBBBEEEEVVVVXXXX((((3333SSSS))))                                                          CCCCHHHHBBBBEEEEVVVVXXXX((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      CHBEVX - compute selected eigenvalues and, optionally, eigenvectors of a
  10.      complex Hermitian band matrix A
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE CHBEVX( JOBZ, RANGE, UPLO, N, KD, AB, LDAB, Q, LDQ, VL, VU,
  14.                         IL, IU, ABSTOL, M, W, Z, LDZ, WORK, RWORK, IWORK,
  15.                         IFAIL, INFO )
  16.  
  17.          CHARACTER      JOBZ, RANGE, UPLO
  18.  
  19.          INTEGER        IL, INFO, IU, KD, LDAB, LDQ, LDZ, M, N
  20.  
  21.          REAL           ABSTOL, VL, VU
  22.  
  23.          INTEGER        IFAIL( * ), IWORK( * )
  24.  
  25.          REAL           RWORK( * ), W( * )
  26.  
  27.          COMPLEX        AB( LDAB, * ), Q( LDQ, * ), WORK( * ), Z( LDZ, * )
  28.  
  29. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  30.      These routines are part of the SCSL Scientific Library and can be loaded
  31.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  32.      directs the linker to use the multi-processor version of the library.
  33.  
  34.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  35.      4 bytes (32 bits). Another version of SCSL is available in which integers
  36.      are 8 bytes (64 bits).  This version allows the user access to larger
  37.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  38.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  39.      only one of the two versions; 4-byte integer and 8-byte integer library
  40.      calls cannot be mixed.
  41.  
  42. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  43.      CHBEVX computes selected eigenvalues and, optionally, eigenvectors of a
  44.      complex Hermitian band matrix A. Eigenvalues and eigenvectors can be
  45.      selected by specifying either a range of values or a range of indices for
  46.      the desired eigenvalues.
  47.  
  48.  
  49. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  50.      JOBZ    (input) CHARACTER*1
  51.              = 'N':  Compute eigenvalues only;
  52.              = 'V':  Compute eigenvalues and eigenvectors.
  53.  
  54.      RANGE   (input) CHARACTER*1
  55.              = 'A': all eigenvalues will be found;
  56.              = 'V': all eigenvalues in the half-open interval (VL,VU] will be
  57.              found; = 'I': the IL-th through IU-th eigenvalues will be found.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCHHHHBBBBEEEEVVVVXXXX((((3333SSSS))))                                                          CCCCHHHHBBBBEEEEVVVVXXXX((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      UPLO    (input) CHARACTER*1
  75.              = 'U':  Upper triangle of A is stored;
  76.              = 'L':  Lower triangle of A is stored.
  77.  
  78.      N       (input) INTEGER
  79.              The order of the matrix A.  N >= 0.
  80.  
  81.      KD      (input) INTEGER
  82.              The number of superdiagonals of the matrix A if UPLO = 'U', or
  83.              the number of subdiagonals if UPLO = 'L'.  KD >= 0.
  84.  
  85.      AB      (input/output) COMPLEX array, dimension (LDAB, N)
  86.              On entry, the upper or lower triangle of the Hermitian band
  87.              matrix A, stored in the first KD+1 rows of the array.  The j-th
  88.              column of A is stored in the j-th column of the array AB as
  89.              follows:  if UPLO = 'U', AB(kd+1+i-j,j) = A(i,j) for max(1,j-
  90.              kd)<=i<=j; if UPLO = 'L', AB(1+i-j,j)    = A(i,j) for
  91.              j<=i<=min(n,j+kd).
  92.  
  93.              On exit, AB is overwritten by values generated during the
  94.              reduction to tridiagonal form.
  95.  
  96.      LDAB    (input) INTEGER
  97.              The leading dimension of the array AB.  LDAB >= KD + 1.
  98.  
  99.      Q       (output) COMPLEX array, dimension (LDQ, N)
  100.              If JOBZ = 'V', the N-by-N unitary matrix used in the reduction to
  101.              tridiagonal form.  If JOBZ = 'N', the array Q is not referenced.
  102.  
  103.      LDQ     (input) INTEGER
  104.              The leading dimension of the array Q.  If JOBZ = 'V', then LDQ >=
  105.              max(1,N).
  106.  
  107.      VL      (input) REAL
  108.              VU      (input) REAL If RANGE='V', the lower and upper bounds of
  109.              the interval to be searched for eigenvalues. VL < VU.  Not
  110.              referenced if RANGE = 'A' or 'I'.
  111.  
  112.      IL      (input) INTEGER
  113.              IU      (input) INTEGER If RANGE='I', the indices (in ascending
  114.              order) of the smallest and largest eigenvalues to be returned.  1
  115.              <= IL <= IU <= N, if N > 0; IL = 1 and IU = 0 if N = 0.  Not
  116.              referenced if RANGE = 'A' or 'V'.
  117.  
  118.      ABSTOL  (input) REAL
  119.              The absolute error tolerance for the eigenvalues.  An approximate
  120.              eigenvalue is accepted as converged when it is determined to lie
  121.              in an interval [a,b] of width less than or equal to
  122.  
  123.              ABSTOL + EPS *   max( |a|,|b| ) ,
  124.  
  125.              where EPS is the machine precision.  If ABSTOL is less than or
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. CCCCHHHHBBBBEEEEVVVVXXXX((((3333SSSS))))                                                          CCCCHHHHBBBBEEEEVVVVXXXX((((3333SSSS))))
  137.  
  138.  
  139.  
  140.              equal to zero, then  EPS*|T|  will be used in its place, where
  141.              |T| is the 1-norm of the tridiagonal matrix obtained by reducing
  142.              AB to tridiagonal form.
  143.  
  144.              Eigenvalues will be computed most accurately when ABSTOL is set
  145.              to twice the underflow threshold 2*SLAMCH('S'), not zero.  If
  146.              this routine returns with INFO>0, indicating that some
  147.              eigenvectors did not converge, try setting ABSTOL to
  148.              2*SLAMCH('S').
  149.  
  150.              See "Computing Small Singular Values of Bidiagonal Matrices with
  151.              Guaranteed High Relative Accuracy," by Demmel and Kahan, LAPACK
  152.              Working Note #3.
  153.  
  154.      M       (output) INTEGER
  155.              The total number of eigenvalues found.  0 <= M <= N.  If RANGE =
  156.              'A', M = N, and if RANGE = 'I', M = IU-IL+1.
  157.  
  158.      W       (output) REAL array, dimension (N)
  159.              The first M elements contain the selected eigenvalues in
  160.              ascending order.
  161.  
  162.      Z       (output) COMPLEX array, dimension (LDZ, max(1,M))
  163.              If JOBZ = 'V', then if INFO = 0, the first M columns of Z contain
  164.              the orthonormal eigenvectors of the matrix A corresponding to the
  165.              selected eigenvalues, with the i-th column of Z holding the
  166.              eigenvector associated with W(i).  If an eigenvector fails to
  167.              converge, then that column of Z contains the latest approximation
  168.              to the eigenvector, and the index of the eigenvector is returned
  169.              in IFAIL.  If JOBZ = 'N', then Z is not referenced.  Note: the
  170.              user must ensure that at least max(1,M) columns are supplied in
  171.              the array Z; if RANGE = 'V', the exact value of M is not known in
  172.              advance and an upper bound must be used.
  173.  
  174.      LDZ     (input) INTEGER
  175.              The leading dimension of the array Z.  LDZ >= 1, and if JOBZ =
  176.              'V', LDZ >= max(1,N).
  177.  
  178.      WORK    (workspace) COMPLEX array, dimension (N)
  179.  
  180.      RWORK   (workspace) REAL array, dimension (7*N)
  181.  
  182.      IWORK   (workspace) INTEGER array, dimension (5*N)
  183.  
  184.      IFAIL   (output) INTEGER array, dimension (N)
  185.              If JOBZ = 'V', then if INFO = 0, the first M elements of IFAIL
  186.              are zero.  If INFO > 0, then IFAIL contains the indices of the
  187.              eigenvectors that failed to converge.  If JOBZ = 'N', then IFAIL
  188.              is not referenced.
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. CCCCHHHHBBBBEEEEVVVVXXXX((((3333SSSS))))                                                          CCCCHHHHBBBBEEEEVVVVXXXX((((3333SSSS))))
  203.  
  204.  
  205.  
  206.      INFO    (output) INTEGER
  207.              = 0:  successful exit
  208.              < 0:  if INFO = -i, the i-th argument had an illegal value
  209.              > 0:  if INFO = i, then i eigenvectors failed to converge.  Their
  210.              indices are stored in array IFAIL.
  211.  
  212. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  213.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  214.  
  215.      This man page is available only online.
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.